Meshtastic App/com.geeksville.mesh/[androidJvm]ModuleConfigProtos/ModuleConfig/MQTTConfig

MQTTConfig

class MQTTConfig : GeneratedMessage, ModuleConfigProtos.ModuleConfig.MQTTConfigOrBuilder


MQTT Client Config

Protobuf type meshtastic.ModuleConfig.MQTTConfig

Types

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , ModuleConfigProtos.ModuleConfig.MQTTConfigOrBuilder


MQTT Client Config

Protobuf type meshtastic.ModuleConfig.MQTTConfig

Properties

ADDRESS_FIELD_NUMBER

val ADDRESS_FIELD_NUMBER: Int = 2

ENABLED_FIELD_NUMBER

val ENABLED_FIELD_NUMBER: Int = 1

ENCRYPTION_ENABLED_FIELD_NUMBER

val ENCRYPTION_ENABLED_FIELD_NUMBER: Int = 5

JSON_ENABLED_FIELD_NUMBER

val JSON_ENABLED_FIELD_NUMBER: Int = 6

MAP_REPORT_SETTINGS_FIELD_NUMBER

val MAP_REPORT_SETTINGS_FIELD_NUMBER: Int = 11

MAP_REPORTING_ENABLED_FIELD_NUMBER

val MAP_REPORTING_ENABLED_FIELD_NUMBER: Int = 10

PASSWORD_FIELD_NUMBER

val PASSWORD_FIELD_NUMBER: Int = 4

PROXY_TO_CLIENT_ENABLED_FIELD_NUMBER

val PROXY_TO_CLIENT_ENABLED_FIELD_NUMBER: Int = 9

ROOT_FIELD_NUMBER

val ROOT_FIELD_NUMBER: Int = 8

TLS_ENABLED_FIELD_NUMBER

val TLS_ENABLED_FIELD_NUMBER: Int = 7

USERNAME_FIELD_NUMBER

val USERNAME_FIELD_NUMBER: Int = 3

Functions

copy

inline fun ModuleConfigProtos.ModuleConfig.MQTTConfig.copy(block: ModuleConfigKt.MQTTConfigKt.Dsl.() -> Unit): ModuleConfigProtos.ModuleConfig.MQTTConfig

equals

open fun equals(obj: Any): Boolean

getAddress

open fun getAddress(): String


The server to use for our MQTT global message gateway feature.
If not set, the default server will be used

string address = 2;

getAddressBytes

open fun getAddressBytes(): ByteString


The server to use for our MQTT global message gateway feature.
If not set, the default server will be used

string address = 2;

getDefaultInstance

open fun getDefaultInstance(): ModuleConfigProtos.ModuleConfig.MQTTConfig

getDefaultInstanceForType

open fun getDefaultInstanceForType(): ModuleConfigProtos.ModuleConfig.MQTTConfig

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getEnabled

open fun getEnabled(): Boolean


If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as
is_uplink_enabled or is_downlink_enabled.

bool enabled = 1;

getEncryptionEnabled

open fun getEncryptionEnabled(): Boolean


Whether to send encrypted or decrypted packets to MQTT.
This parameter is only honoured if you also set server
(the default official mqtt.meshtastic.org server can handle encrypted packets)
Decrypted packets may be useful for external systems that want to consume meshtastic packets

bool encryption_enabled = 5;

getJsonEnabled

open fun getJsonEnabled(): Boolean


Whether to send / consume json packets on MQTT

bool json_enabled = 6;

getMapReportingEnabled

open fun getMapReportingEnabled(): Boolean


If true, we will periodically report unencrypted information about our node to a map via MQTT

bool map_reporting_enabled = 10;

getMapReportSettings

open fun getMapReportSettings(): ModuleConfigProtos.ModuleConfig.MapReportSettings


Settings for reporting information about our node to a map via MQTT

.meshtastic.ModuleConfig.MapReportSettings map_report_settings = 11;

getMapReportSettingsOrBuilder

open fun getMapReportSettingsOrBuilder(): ModuleConfigProtos.ModuleConfig.MapReportSettingsOrBuilder


Settings for reporting information about our node to a map via MQTT

.meshtastic.ModuleConfig.MapReportSettings map_report_settings = 11;

getParserForType

open fun getParserForType(): Parser<ModuleConfigProtos.ModuleConfig.MQTTConfig>

getPassword

open fun getPassword(): String


MQTT password to use (most useful for a custom MQTT server).
If using a custom server, this will be honoured even if empty.
If using the default server, this will only be honoured if set, otherwise the device will use the default password

string password = 4;

getPasswordBytes

open fun getPasswordBytes(): ByteString


MQTT password to use (most useful for a custom MQTT server).
If using a custom server, this will be honoured even if empty.
If using the default server, this will only be honoured if set, otherwise the device will use the default password

string password = 4;

getProxyToClientEnabled

open fun getProxyToClientEnabled(): Boolean


If true, we can use the connected phone / client to proxy messages to MQTT instead of a direct connection

bool proxy_to_client_enabled = 9;

getRoot

open fun getRoot(): String


The root topic to use for MQTT messages. Default is "msh".
This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs

string root = 8;

getRootBytes

open fun getRootBytes(): ByteString


The root topic to use for MQTT messages. Default is "msh".
This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs

string root = 8;

getSerializedSize

open fun getSerializedSize(): Int

getTlsEnabled

open fun getTlsEnabled(): Boolean


If true, we attempt to establish a secure connection using TLS

bool tls_enabled = 7;

getUsername

open fun getUsername(): String


MQTT username to use (most useful for a custom MQTT server).
If using a custom server, this will be honoured even if empty.
If using the default server, this will only be honoured if set, otherwise the device will use the default username

string username = 3;

getUsernameBytes

open fun getUsernameBytes(): ByteString


MQTT username to use (most useful for a custom MQTT server).
If using a custom server, this will be honoured even if empty.
If using the default server, this will only be honoured if set, otherwise the device will use the default username

string username = 3;

hashCode

open fun hashCode(): Int

hasMapReportSettings

open fun hasMapReportSettings(): Boolean


Settings for reporting information about our node to a map via MQTT

.meshtastic.ModuleConfig.MapReportSettings map_report_settings = 11;

isInitialized

fun isInitialized(): Boolean

newBuilder

open fun newBuilder(): ModuleConfigProtos.ModuleConfig.MQTTConfig.Builder

open fun newBuilder(prototype: ModuleConfigProtos.ModuleConfig.MQTTConfig): ModuleConfigProtos.ModuleConfig.MQTTConfig.Builder

newBuilderForType

open fun newBuilderForType(): ModuleConfigProtos.ModuleConfig.MQTTConfig.Builder

parseDelimitedFrom

open fun parseDelimitedFrom(input: InputStream): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseDelimitedFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): ModuleConfigProtos.ModuleConfig.MQTTConfig

parseFrom

open fun parseFrom(data: Array<Byte>): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseFrom(data: ByteString): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseFrom(input: CodedInputStream): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseFrom(input: InputStream): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseFrom(data: ByteBuffer): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseFrom(data: Array<Byte>, extensionRegistry: ExtensionRegistryLite): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseFrom(data: ByteString, extensionRegistry: ExtensionRegistryLite): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): ModuleConfigProtos.ModuleConfig.MQTTConfig

open fun parseFrom(data: ByteBuffer, extensionRegistry: ExtensionRegistryLite): ModuleConfigProtos.ModuleConfig.MQTTConfig

parser

open fun parser(): Parser<ModuleConfigProtos.ModuleConfig.MQTTConfig>

toBuilder

open fun toBuilder(): ModuleConfigProtos.ModuleConfig.MQTTConfig.Builder

writeTo

open fun writeTo(output: CodedOutputStream)